home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Source Code / C / Applications / UIFlow 1.0.1 / UIFlow Source / VSet2.0 / temp / vg.h < prev    next >
Encoding:
C/C++ Source or Header  |  1991-12-16  |  9.7 KB  |  316 lines  |  [TEXT/????]
  1. /*****************************************************************************
  2. * 
  3. *              NCSA HDF Vset release 2.1
  4. *                    May 1991
  5. *
  6. * NCSA HDF Vset release 2.1 source code and documentation are in the public
  7. * domain.  Specifically, we give to the public domain all rights for future
  8. * licensing of the source code, all resale rights, and all publishing rights.
  9. * 
  10. * We ask, but do not require, that the following message be included in all
  11. * derived works:
  12. * 
  13. * Portions developed at the National Center for Supercomputing Applications at
  14. * the University of Illinois at Urbana-Champaign.
  15. * 
  16. * THE UNIVERSITY OF ILLINOIS GIVES NO WARRANTY, EXPRESSED OR IMPLIED, FOR THE
  17. * SOFTWARE AND/OR DOCUMENTATION PROVIDED, INCLUDING, WITHOUT LIMITATION,
  18. * WARRANTY OF MERCHANTABILITY AND WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE
  19. * 
  20. *****************************************************************************
  21. *  Likkai Ng MAY 91  NCSA
  22. * 
  23. * vg.h
  24. * Part of HDF VSet interface
  25. *
  26. * defines symbols and structures used in all v*.c files    
  27. *
  28. * NOTES:
  29. * This include file depends on the basic HDF *.h files dfi.h and df.h.
  30. * An 'S' in the comment means that that data field is saved in the HDF file.
  31. *
  32. ******************************************************************************/
  33.  
  34.  
  35. #include <df.h>
  36.  
  37. #define PUBLIC        
  38. #define PRIVATE    static
  39.  
  40.  
  41. /* 
  42. * interlacing supported by the vset. 
  43. */
  44.  
  45. #define FULL_INTERLACE    0
  46. #define NO_INTERLACE        1
  47.  
  48. /* 
  49. * some max lengths 
  50. *
  51. * Except for FIELDNAMELENMAX, change these as you please, they 
  52. * affect memory only, not the file. 
  53. *
  54. */
  55.  
  56. #define FIELDNAMELENMAX    16                /* fieldname   : 16 chars max */
  57.  
  58. #define VSFIELDMAX        20              /* max no of fields per vdata */
  59. #define VSNAMELENMAX        64                /* vdata name  : 64 chars max */    
  60. #define VGNAMELENMAX        64                /* vgroup name : 64 chars max */    
  61. #define VFILEMAX             40             /* max no of files that may be opened */
  62. /* actually, for now, this is the max # of file units that can be used */
  63.  
  64.  
  65. /*
  66. * definition of the 2 data elements of the vset.
  67. */
  68.  
  69. typedef struct vgroup_desc         VGROUP;
  70. typedef struct vdata_desc            VDATA;
  71.  
  72. typedef VDATA VSUBGROUP;
  73.  
  74.  
  75. /*
  76. * -----------------------------------------------------------------
  77. * structures that are part of the VDATA structure
  78. * -----------------------------------------------------------------
  79. */
  80.  
  81. typedef struct symdef_struct 
  82. {
  83.     char* name;                        /* symbol name */
  84.     int    type;                        /* whether int, char, float etc */
  85.     int    isize;                    /* field size as stored in vdata */
  86.     int    order;                    /* order of field */
  87.  
  88.     } SYMDEF;
  89.  
  90. typedef struct write_struct    
  91. {
  92.     int32    n;                            /* S actual # fields in element */
  93.     int    ivsize;                    /* S size of element as stored in vdata */
  94.      char     name[VSFIELDMAX][FIELDNAMELENMAX+1];
  95.                                         /* S name of each field */
  96.     int    len[VSFIELDMAX];         /* S length of each fieldname */
  97.     int    type[VSFIELDMAX];        /* S field type */
  98.       int    off[VSFIELDMAX];        /* S field offset in element in vdata */
  99.       int     isize[VSFIELDMAX];    /* S internal (HDF) size [incl order] */
  100.       int    order[VSFIELDMAX];    /* S order of field */
  101.       int    esize[VSFIELDMAX];    /*  external (local machine) size [incl order] */
  102.     int    (*toIEEEfn  [VSFIELDMAX] )();
  103.     int    (*fromIEEEfn[VSFIELDMAX] )();
  104.  
  105.       }         VWRITELIST;
  106.  
  107. typedef struct read_struct
  108. {
  109.     int    n;                         /* # fields to read */
  110.     int    item[VSFIELDMAX];     /* index into vftable_struct */
  111.  
  112.     } VREADLIST;
  113.  
  114. /* 
  115. *  ----------------------------------------------- 
  116.         V G R O U P     definition     
  117. *  ----------------------------------------------- 
  118. */
  119.  
  120. #define MAXNVELT  36                /* max no of elements in a vgroup */
  121.  
  122. struct vgroup_desc
  123. { 
  124.     int    otag, oref;            /* tag-ref of this vgroup */
  125.       DF         *f;                          /* HDF file ptr */
  126.     int16     nvelt;                     /* S no of elements */
  127.       int     access;                    /* 'r' or 'w' */
  128.     int     tag[MAXNVELT];        /* S tag of element */
  129.     int     ref[MAXNVELT];        /* S ref of element */
  130.      char     vgname[VGNAMELENMAX+1];/* S name of this vgroup */
  131.      char     vgclass[VGNAMELENMAX+1];/*  class name of this vgroup */
  132.     VDATA* velt[MAXNVELT];         /* pts to a element if opened; or else NULL */
  133.     int    marked;                    /* =1 if new info has been added to vgroup */
  134.     int16        extag, exref;            /* expansion tag-ref */
  135.     int16        version, more;            /* version and "more" field */    
  136.  
  137.     };                                    /* VGROUP */
  138.  
  139. /*
  140. *  ----------------------------------------------- 
  141. *         V D A T A      definition   
  142. *  ----------------------------------------------- 
  143. */
  144.  
  145. #define USYMMAX 36                /* max user-defined symbols allowed */
  146.  
  147. struct vdata_desc{ 
  148.       int    otag, oref;             /* tag,ref of this vdata */
  149.       DF        *f;                          /* HDF file ptr */
  150.       int    access;                    /* 'r' or 'w' */
  151.      char    vsname[VSNAMELENMAX+1];/* S name of this vdata */
  152.      char    vsclass[VSNAMELENMAX+1];/* class name of this vdata */
  153.       int    interlace;                /* S  interlace as in file */
  154.       int32    nvertices;                /* S  #vertices in this vdata */
  155.     int    vpos;                    /* cur position (in terms of elements) */
  156.     VWRITELIST    wlist;
  157.       VREADLIST    rlist;
  158.     int              nusym;
  159.     SYMDEF         usym[USYMMAX];
  160.     int    marked;                    /* =1 if new info has been added to vdata */
  161.  
  162.     int16        extag, exref;            /* expansion tag-ref */
  163.     int16        version, more;            /* version and "more" field */    
  164.  
  165.       };                                  /* VDATA */ 
  166.  
  167. /* MACROS - Use these for accessing field components of vdata. */
  168.  
  169. #define VFnfields(vdata)         (vdata->wlist.n)
  170. #define VFfieldname(vdata,t)     (vdata->wlist.name[t])
  171. #define VFfieldtype(vdata,t)     (vdata->wlist.type[t])
  172. #define VFfieldisize(vdata,t)     (vdata->wlist.isize[t])
  173. #define VFfieldesize(vdata,t)     (vdata->wlist.esize[t])
  174. #define VFfieldorder(vdata,t)     (vdata->wlist.order[t])
  175.  
  176.  
  177. /* --------------  H D F    V S E T   tags  ---------------------------- */
  178.  
  179. #define OLD_VGDESCTAG      61820        /* tag for a vgroup d*/ 
  180. #define OLD_VSDESCTAG     61821        /* tag for a vdata descriptor */
  181. #define OLD_VSDATATAG     61822        /* tag for actual raw data of a vdata */ 
  182.  
  183. #define NEW_VGDESCTAG    1965
  184. #define NEW_VSDESCTAG    1962
  185. #define NEW_VSDATATAG    1963
  186.  
  187. #define VGDESCTAG         NEW_VGDESCTAG 
  188. #define VSDESCTAG         NEW_VSDESCTAG 
  189. #define VSDATATAG          NEW_VSDATATAG 
  190.  
  191. /*
  192. * Actual sizes of data types stored in HDF file, and are IEEE-defined. 
  193. */
  194.  
  195. #define IEEE_UNTYPEDSIZE   0
  196. #define IEEE_CHARSIZE      1
  197. #define IEEE_INT16SIZE     2
  198. #define IEEE_INT32SIZE     4
  199. #define IEEE_FLOATSIZE     4
  200.  
  201. /*
  202. * types used in defining a new field via a call to VSfdefine
  203. */
  204.  
  205. #define LOCAL_NOTYPE            0
  206. #define LOCAL_CHARTYPE      1
  207. #define LOCAL_INTTYPE          2
  208. #define LOCAL_FLOATTYPE        3
  209. #define LOCAL_LONGTYPE          4
  210.  
  211. /*
  212. * actual LOCAL MACHINE sizes of the above types
  213. */
  214.  
  215. #define LOCAL_UNTYPEDSIZE  0
  216. #define LOCAL_CHARSIZE      sizeof(unsigned char)
  217. #define LOCAL_INTSIZE          sizeof(int)
  218. #define LOCAL_LONGSIZE         sizeof(long)
  219. #define LOCAL_FLOATSIZE     sizeof(float)
  220.  
  221. /* ------------------------------------------------------------------ */
  222. /* 2 GLOBAL VARIABLES (int vjv and char sj[]) provide a simple
  223. * debugging scheme. Debugging is turned on and off via calls to 
  224. * setjj and setnojj. These globals and functions are found in vgp.c.
  225. * 
  226. * If the debug feature is no longer needed, delete all these, and
  227. * all statements that refer to xzj,sjs, and vjv from the source
  228. *
  229. */
  230.  
  231. extern int         vjv;             /* debugger switch */
  232. extern char     sjs[];         /* contains the debug/error message */
  233.  
  234. /* zj just prints out the contents of the text buffer sjs. */
  235. /* sjs contains debugging messages when debug is on */
  236. /* for the Mac, replace define zj to be any print msg routine */
  237.  
  238. #ifdef MAC
  239. #define zj
  240. #else
  241. #define zj         fprintf(stderr,"%s",sjs) 
  242. #endif
  243.  
  244. /* Macros for returning null, -1 or no value with a message */
  245.  
  246. #define FAIL -1
  247. #define RTNULL(ss) { sprintf(sjs,"@%s\n",ss); zj; return(NULL); }
  248. #define RTNEG(ss) { sprintf(sjs,"@%s\n",ss); zj; return(FAIL); }
  249. #define RT(ss) { sprintf(sjs,"@%s\n",ss); zj; return; }
  250.  
  251. /* .................................................................. */
  252. /* Private data structures. Unlikely to be of interest to applications */
  253. /* 
  254. * These are just typedefs. Actual vfile_ts are declared PRIVATE and
  255. * are not accessible by applications. However, you may change VFILEMAX
  256. * to allow however many files to be opened.
  257. *
  258. * These are memory-resident copies of the tag-refs of the vgroups
  259. * and vdatas for each file that is opened.
  260. * 
  261. */
  262.  
  263. /* this is a memory copy of a vs tag/ref found in the file */
  264. typedef struct vg_instance_struct {
  265.     int     ref;            /* ref # of this vgroup in the file */
  266.     int     nattach;        /* # of current attachs to this vgroup */
  267.     int     nentries;    /* # of entries in that vgroup initially */
  268.     VGROUP *vg;            /* points to the vg when it is attached */
  269. struct vg_instance_struct * next;
  270. }    vginstance_t; 
  271.  
  272. /* this is a memory copy of a vs tag/ref found in the file */
  273. typedef struct vs_instance_struct {
  274.     int    ref;            /* ref # of this vdata in the file */
  275.     int    nattach;        /* # of current attachs to this vdata */
  276.     int    nvertices;    /* # of elements in that vdata initially */
  277.     VDATA    * vs;         /* points to the vdata when it is attached */
  278.     struct vs_instance_struct * next;
  279. }    vsinstance_t; 
  280.  
  281. /* each vfile_t maintains 2 linked lists: one of vgs and one of vdatas
  282. * that already exist or are just created for a given file.  */
  283.  
  284. typedef struct vfiledir_struct {
  285.     DF            * f;
  286.  
  287.    int                vgtabn;                /* # of vg entries in vgtab so far */
  288.     vginstance_t    vgtab;                /* start of vg linked list */
  289.    vginstance_t    *vgtabtail;             /* its tail end */
  290.  
  291.    int                vstabn;                /* # of vs entries in vstab so far */
  292.     vsinstance_t    vstab;                /* start of vs linked list */
  293.    vsinstance_t    *vstabtail;            /* its tail end */
  294. } vfile_t;
  295.  
  296. /* .................................................................. */
  297. #define VSET_VERSION 2                    /* DO NOT CHANGE!! */
  298.  
  299.  
  300. #ifdef MAC
  301. #include "vset-prototypes.h"
  302. #include <String.h>
  303. #include <ctype.h>
  304. #endif
  305.  
  306.  
  307. /* 
  308. * DFopen and DFclose are redefined to perform additional work, 
  309. * ie Vset data structure initialization and clean-up.
  310. * Does not affect usage by other HDF interfaces.
  311. */
  312.  
  313. #define DFopen (DF*)DFvsetopen
  314. #define DFclose DFvsetclose
  315.  
  316.